/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Aug 20, 2019 (Adrian Nembach, KNIME GmbH, Konstanz, Germany): created
 */
package org.knime.base.node.preproc.topk;

import org.knime.core.node.util.ButtonGroupEnumInterface;

enum OutputOrder implements ButtonGroupEnumInterface {
        /**
         * The user does not care about the output order so no pre- and postprocessing is performed to keep the runtime
         * as low as possible.
         */
        NO_ORDER("No order", OrderPreprocessors.noOp(), OrderPostprocessors.noOp()),
        /**
         * The input order should be retained i.e. the order of the selected rows should be the same as in the input
         * table. </br>
         * Preprocessing: An artificial order column is added. Postprocessing: The selection is sorted according to the
         * order column which is removed afterwards.
         */
        RETAIN("Retain order", OrderPreprocessors.appendInOrderColumn(),
            OrderPostprocessors.chain(OrderPostprocessors.sort(OrderPostprocessors::compareInputOrderColumn),
                OrderPostprocessors.removeLastColumn())),
        /**
         * The output table should be sorted according to the selection criterion. </br>
         * Preprocessing: An artificial order column is added. Postprocessing: The selection is sorted according to the
         * user-specified selection criterion with tie-breaking according to the input order. The order column is
         * removed afterwards.
         */
        SORT("Sort output", OrderPreprocessors.appendInOrderColumn(),
            OrderPostprocessors.chain((s, c) -> OrderPostprocessors
                .sort(OrderPostprocessors.chain(c, OrderPostprocessors::compareInputOrderColumn))
                .postprocessSelection(s, c), OrderPostprocessors.removeLastColumn()));

    private OutputOrder(final String text, final OrderPreprocessor preprocessor,
        final OrderPostprocessor postprocessor) {
        m_text = text;
        m_preprocessor = preprocessor;
        m_postprocessor = postprocessor;
    }

    private final String m_text;

    private final OrderPreprocessor m_preprocessor;

    private final OrderPostprocessor m_postprocessor;

    OrderPreprocessor getPreprocessor() {
        return m_preprocessor;
    }

    OrderPostprocessor getPostprocessor() {
        return m_postprocessor;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getText() {
        return m_text;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getActionCommand() {
        return name();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getToolTip() {
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isDefault() {
        return this == RETAIN;
    }
}